Typ złożony StatusRequest

Opis

Żądanie pobrania statusu / rezultatu zlecenia

Typ opisujący strukturę żądania pobrania statusu / rezultatu zlecenia

Przestrzeń nazw

http://api.big.pl/bimoS/v1

Typ podstawowy

Extension of Typ złożony Request

Diagram

Przegląd

StatusRequest Extension of Typ złożony Request

Żądanie pobrania statusu / rezultatu zlecenia

Typ opisujący strukturę żądania pobrania statusu / rezultatu zlecenia

responseScope optional Typ prosty responseScopeEnum

Rezultat zlecenia

Zakres danych zwracany w wyniku przetworzenia żądania pobrania statusu / rezultatu zlecenia

Sequence

Choice

client Typ złożony Subscriber

Klient BIG IM przeprowadzający operację

Element, który zawiera identyfikatory Klienta zlecającego operację

Sequence

clientId Typ prosty id

Identyfikator subskrybenta

Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.

unitId Typ prosty id

Identyfikator jednostki organizacyjnej subskrybenta

Unikalny w ramach Klienta identyfikator nadawany przez BIG InfoMonitor każdej jednostce organizacyjnej subskrybenta.

proxy Typ złożony Proxy

Przedstawiciel Klienta

Identyfikatory Przedstawiciela klienta BIG IM, przeprowadzający operację w jego imieniu

Sequence

proxy Typ złożony Subscriber

Dane przedstawiciela klienta BIG IM, przeprowadzającego operację w jego imieniu

Sequence

clientId Typ prosty id

Identyfikator subskrybenta

Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.

unitId Typ prosty id

Identyfikator jednostki organizacyjnej subskrybenta

Unikalny w ramach Klienta identyfikator nadawany przez BIG InfoMonitor każdej jednostce organizacyjnej subskrybenta.

client Typ złożony Subscriber

Dane klienta BIG IM w imieniu, którego przeprowadzana jest operacja

Powiązane reguły walidacji:

Identyfikator	Opis
RAIG280	Subskrybent będący osobą fizyczną nie może przekazać Informacji Gospodarczej Pozytywnej i o Dokumencie Kwestionowanym

Sequence

clientId Typ prosty id

Identyfikator subskrybenta

Unikalny identyfikator nadawany przez BIG InfoMonitor każdemu subskrybentowi w ramach systemu.

unitId Typ prosty id

Identyfikator jednostki organizacyjnej subskrybenta

Unikalny w ramach Klienta identyfikator nadawany przez BIG InfoMonitor każdej jednostce organizacyjnej subskrybenta.

clientUserId Typ prosty string32

Identyfikator operatora

Identyfikator operatora, pracownika Klienta, nadany przez BIG InfoMonitor każdemu użytkownikowi (operatorowi) systemu. W imieniu wskazanego w tym polu operatora wywoływane są operacje w bazie BIG IM.

validityDateTime optional Typ prosty dateTime

Data i czas aktualności danych

Wskazanie daty i czasu na który aktualne są przekazywane do BIG InfoMonitor dane. Domyślnie SIBIG przyjmuje, że przekazywane dane są aktualne na moment wywołania usługi BIG InfoMonitor przez system Subskrybenta.

orderId Typ prosty string32

Identyfikator zlecenia

Identyfikator zlecenia, dla którego dostępny jest rezultat

Używany przez

Element getOrderStatusRequest

Atrybuty

Nazwa	Typ	Używa	Domyślnie	Stały	Opis
responseScope	Typ prosty responseScopeEnum	optional	orderResult		Rezultat zlecenia Zakres danych zwracany w wyniku przetworzenia żądania pobrania statusu / rezultatu zlecenia

Źródło

<xs:complexType name="StatusRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Żądanie pobrania statusu / rezultatu zlecenia</div>
      <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Typ opisujący strukturę żądania pobrania statusu / rezultatu zlecenia</div>
    </xs:documentation>
  </xs:annotation>
  <xs:complexContent>
    <xs:extension base="bs:Request">
      <xs:sequence>
        <xs:element name="orderId" type="bc:string32">
          <xs:annotation>
            <xs:documentation>
              <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator zlecenia</div>
              <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Identyfikator zlecenia, dla którego dostępny jest rezultat</div>
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
      <xs:attribute name="responseScope" type="bs:responseScopeEnum" default="orderResult">
        <xs:annotation>
          <xs:documentation>
            <div class="nazwa pl-PL" xmlns="http://www.w3.org/1999/xhtml">Rezultat zlecenia</div>
            <div class="opis pl-PL" xmlns="http://www.w3.org/1999/xhtml">Zakres danych zwracany w wyniku przetworzenia żądania pobrania statusu / rezultatu zlecenia</div>
          </xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

Zobacz także

Schema bimoS.v1